<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>common_util: src/common_util/config.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">common_util
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_2961cad218251a7c35c6867350b80887.html">common_util</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">config.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Config for common_util library, such as initialization and destory for library.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="logtype_8h_source.html">logtype.h</a>&quot;</code><br />
</div>
<p><a href="config_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a01de4212c199745ff089ca5d89a064e8" id="r_a01de4212c199745ff089ca5d89a064e8"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a01de4212c199745ff089ca5d89a064e8">cutl::library_name</a> ()</td></tr>
<tr class="memdesc:a01de4212c199745ff089ca5d89a064e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the library.  <br /></td></tr>
<tr class="separator:a01de4212c199745ff089ca5d89a064e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e5151f926522895af2783a1e5dd481a" id="r_a0e5151f926522895af2783a1e5dd481a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0e5151f926522895af2783a1e5dd481a">cutl::library_version</a> ()</td></tr>
<tr class="memdesc:a0e5151f926522895af2783a1e5dd481a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version of the library.  <br /></td></tr>
<tr class="separator:a0e5151f926522895af2783a1e5dd481a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaff727190c9cbd114cb8123f3e61e93f" id="r_aaff727190c9cbd114cb8123f3e61e93f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaff727190c9cbd114cb8123f3e61e93f">cutl::library_init</a> (<a class="el" href="logtype_8h.html#a3ed54d05c652f02b6e80ce9bcfe61166">LogFuncType</a> log_func)</td></tr>
<tr class="memdesc:aaff727190c9cbd114cb8123f3e61e93f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the library.  <br /></td></tr>
<tr class="separator:aaff727190c9cbd114cb8123f3e61e93f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Config for common_util library, such as initialization and destory for library. </p>
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (c) 2024, Spencer.Luo. All Rights Reserved.</dd></dl>
<p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at </p><pre class="fragment">  http://www.apache.org/licenses/LICENSE-2.0
</pre><p> Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations.</p>
<dl class="section author"><dt>Author</dt><dd>spencer.luo </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2024-05-13 </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aaff727190c9cbd114cb8123f3e61e93f" name="aaff727190c9cbd114cb8123f3e61e93f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaff727190c9cbd114cb8123f3e61e93f">&#9670;&#160;</a></span>library_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cutl::library_init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="logtype_8h.html#a3ed54d05c652f02b6e80ce9bcfe61166">LogFuncType</a></td>          <td class="paramname"><span class="paramname"><em>log_func</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize the library. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">log_func</td><td>The function pointer for LogFuncType, register a log function for the library. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a01de4212c199745ff089ca5d89a064e8" name="a01de4212c199745ff089ca5d89a064e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01de4212c199745ff089ca5d89a064e8">&#9670;&#160;</a></span>library_name()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string cutl::library_name </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the name of the library. </p>
<dl class="section return"><dt>Returns</dt><dd>library name. </dd></dl>

</div>
</div>
<a id="a0e5151f926522895af2783a1e5dd481a" name="a0e5151f926522895af2783a1e5dd481a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e5151f926522895af2783a1e5dd481a">&#9670;&#160;</a></span>library_version()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string cutl::library_version </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the version of the library. </p>
<dl class="section return"><dt>Returns</dt><dd>the version of the library </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>
